<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PxRepXSerializer Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="PhysXLogoBlack.png"/></td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classPxRepXSerializer.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="classPxRepXSerializer-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">PxRepXSerializer Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group__Serializers.html">Serializers</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>Serializer interface for RepX (Xml) serialization.  
 <a href="classPxRepXSerializer.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="PxRepXSerializer_8h_source.html">PxRepXSerializer.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a91effb5024aa5a90fbbdbf7f17eba795"><td class="memItemLeft" align="right" valign="top">virtual const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxRepXSerializer.html#a91effb5024aa5a90fbbdbf7f17eba795">getTypeName</a> ()=0</td></tr>
<tr class="memdesc:a91effb5024aa5a90fbbdbf7f17eba795"><td class="mdescLeft">&#160;</td><td class="mdescRight">The type this Serializer is meant to operate on.  <a href="#a91effb5024aa5a90fbbdbf7f17eba795">More...</a><br /></td></tr>
<tr class="separator:a91effb5024aa5a90fbbdbf7f17eba795"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac818078a2cd3b41cdaf26ee5bf0e1f35"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxRepXSerializer.html#ac818078a2cd3b41cdaf26ee5bf0e1f35">objectToFile</a> (const <a class="el" href="structPxRepXObject.html">PxRepXObject</a> &amp;inLiveObject, <a class="el" href="classPxCollection.html">PxCollection</a> *inCollection, XmlWriter &amp;inWriter, MemoryBuffer &amp;inTempBuffer, <a class="el" href="structPxRepXInstantiationArgs.html">PxRepXInstantiationArgs</a> &amp;inArgs)=0</td></tr>
<tr class="memdesc:ac818078a2cd3b41cdaf26ee5bf0e1f35"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert from a RepX object to a key-value pair hierarchy.  <a href="#ac818078a2cd3b41cdaf26ee5bf0e1f35">More...</a><br /></td></tr>
<tr class="separator:ac818078a2cd3b41cdaf26ee5bf0e1f35"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7855c4cc5d86b72852018f2652ac60cb"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structPxRepXObject.html">PxRepXObject</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxRepXSerializer.html#a7855c4cc5d86b72852018f2652ac60cb">fileToObject</a> (XmlReader &amp;inReader, XmlMemoryAllocator &amp;inAllocator, <a class="el" href="structPxRepXInstantiationArgs.html">PxRepXInstantiationArgs</a> &amp;inArgs, <a class="el" href="classPxCollection.html">PxCollection</a> *inCollection)=0</td></tr>
<tr class="memdesc:a7855c4cc5d86b72852018f2652ac60cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert from a descriptor to a live object. Must be an object of this Serializer type.  <a href="#a7855c4cc5d86b72852018f2652ac60cb">More...</a><br /></td></tr>
<tr class="separator:a7855c4cc5d86b72852018f2652ac60cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:aa7d45faa6e6fb1e464249762d88b599e"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPxRepXSerializer.html#aa7d45faa6e6fb1e464249762d88b599e">~PxRepXSerializer</a> ()</td></tr>
<tr class="separator:aa7d45faa6e6fb1e464249762d88b599e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Serializer interface for RepX (Xml) serialization. </p>
<p>In order to serialize a class to RepX both a <a class="el" href="classPxSerializer.html" title="Serialization interface class. ">PxSerializer</a> and a <a class="el" href="classPxRepXSerializer.html" title="Serializer interface for RepX (Xml) serialization. ">PxRepXSerializer</a> implementation are needed.</p>
<p>A repx Serializer provides the ability to capture a live object to a descriptor or static state and the ability to write that state out to a file. Objects allocated by the Serializer using the allocator are freed when the collection itself is freed. SnRepXCoreSerializers.cpp implements a set of Serializers for the core PhysX types.</p>
<dl class="section note"><dt>Note</dt><dd>Implementing a <a class="el" href="classPxRepXSerializer.html" title="Serializer interface for RepX (Xml) serialization. ">PxRepXSerializer</a> is currently not practical without including the internal PhysXExtension header "SnRepXSerializerImpl.h".</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPxSerializer.html" title="Serialization interface class. ">PxSerializer</a>, <a class="el" href="group__Serializers.html#ga6018c37f238db16a878cfcba49091c4a" title="Preprocessor macro for RepX serializer creation. ">PX_NEW_REPX_SERIALIZER</a>, <a class="el" href="classPxSerializationRegistry.html#a8c22f511770403078c3a0616251014e4" title="Register a RepX serializer for a concrete type. ">PxSerializationRegistry::registerRepXSerializer</a> </dd></dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aa7d45faa6e6fb1e464249762d88b599e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa7d45faa6e6fb1e464249762d88b599e">&#9670;&nbsp;</a></span>~PxRepXSerializer()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual PxRepXSerializer::~PxRepXSerializer </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a7855c4cc5d86b72852018f2652ac60cb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7855c4cc5d86b72852018f2652ac60cb">&#9670;&nbsp;</a></span>fileToObject()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="structPxRepXObject.html">PxRepXObject</a> PxRepXSerializer::fileToObject </td>
          <td>(</td>
          <td class="paramtype">XmlReader &amp;&#160;</td>
          <td class="paramname"><em>inReader</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">XmlMemoryAllocator &amp;&#160;</td>
          <td class="paramname"><em>inAllocator</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structPxRepXInstantiationArgs.html">PxRepXInstantiationArgs</a> &amp;&#160;</td>
          <td class="paramname"><em>inArgs</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classPxCollection.html">PxCollection</a> *&#160;</td>
          <td class="paramname"><em>inCollection</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Convert from a descriptor to a live object. Must be an object of this Serializer type. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">inReader</td><td>The inverse of the writer, a key-value pair database. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">inAllocator</td><td>An allocator to use for temporary allocations. These will be freed after instantiation completes. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">inArgs</td><td>The arguments used in create resources and objects. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">inCollection</td><td>The collection used to find references.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The new live object. It can be an invalid object if the instantiation cannot take place. </dd></dl>

</div>
</div>
<a id="a91effb5024aa5a90fbbdbf7f17eba795"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a91effb5024aa5a90fbbdbf7f17eba795">&#9670;&nbsp;</a></span>getTypeName()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual const char* PxRepXSerializer::getTypeName </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>The type this Serializer is meant to operate on. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structPxRepXObject.html#a0c78e70aff2c5ede506a1279562e494a" title="Identifies the extension meant to handle this object. ">PxRepXObject::typeName</a> </dd></dl>

</div>
</div>
<a id="ac818078a2cd3b41cdaf26ee5bf0e1f35"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac818078a2cd3b41cdaf26ee5bf0e1f35">&#9670;&nbsp;</a></span>objectToFile()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PxRepXSerializer::objectToFile </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structPxRepXObject.html">PxRepXObject</a> &amp;&#160;</td>
          <td class="paramname"><em>inLiveObject</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classPxCollection.html">PxCollection</a> *&#160;</td>
          <td class="paramname"><em>inCollection</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">XmlWriter &amp;&#160;</td>
          <td class="paramname"><em>inWriter</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">MemoryBuffer &amp;&#160;</td>
          <td class="paramname"><em>inTempBuffer</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structPxRepXInstantiationArgs.html">PxRepXInstantiationArgs</a> &amp;&#160;</td>
          <td class="paramname"><em>inArgs</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Convert from a RepX object to a key-value pair hierarchy. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">inLiveObject</td><td>The object to convert to the passed in descriptor. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">inCollection</td><td>The collection to use to find ids of references of this object. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">inWriter</td><td>Interface to write data to. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">inTempBuffer</td><td>used to for temporary allocations. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">inArgs</td><td>The arguments used in create resources and objects. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PxRepXSerializer_8h_source.html">PxRepXSerializer.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.14-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="classPxRepXSerializer.html">PxRepXSerializer</a></li>
    <li class="footer">Copyright &copy; 2008-2021 NVIDIA Corporation, 2788 San Tomas Expressway, Santa Clara, CA 95051 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a></li>
  </ul>
</div>
</body>
</html>
